home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / wordproc / hshell1.arj / BEGINNER.DOC < prev    next >
Text File  |  1993-12-29  |  6KB  |  118 lines
  1.       Introduction to creating hyperfiles - Version 4
  2.       ===============================================
  3.  
  4.       So, you want to create your own hypertext application?
  5.  
  6.       You should start by finding out how the HyperShell program is used,
  7.       by  reading  the  HS  hyperfile  (choose 'Introduction' on the HOME
  8.       menu) first.  This will let you  see  the  basic  concepts  of  the
  9.       system,  and  the  kinds of thing it can provide. Running the other
  10.       demonstrations can also show the capabilities of the system.
  11.  
  12.       HyperShell is a very  complex  program  and  handles  very  complex
  13.       hyperfiles.  This  does  NOT  mean that you have to know everything
  14.       about it before you start. The more powerful features can be learnt
  15.       as and when you need them.
  16.  
  17.       To show how simple a file can be, try giving the name of any normal
  18.       text file to HyperShell (such as the READ.ME file):-
  19.  
  20.       HS READ.ME
  21.  
  22.       This gets treated as a single 'frame' hyperfile which you can  page
  23.       through,  and  use  F10  to  exit  from.  A basic hyperfile should,
  24.       however, contain frames with references  between  them.  Hyperfiles
  25.       are files with the extension .HYP, and are text files like this one
  26.       or  the READ.ME file, or batch files. Examining the MSDOS hyperfile
  27.       and the other examples, you will see how to set up different  types
  28.       of application. Some of the supplied hyperfiles are compressed, but
  29.       may  be  expanded  again  to  text files using the HCX utility, the
  30.       instructions for which are in the documentation.
  31.  
  32.       The notefile hyperfile
  33.       ----------------------
  34.  
  35.       The demo  notefile  hyperfile  is  the  basis  for  a  simple  text
  36.       database,  and  you should use this first to become  familiar  with
  37.       the editing arrangements in the integrated environment. You can
  38.       run this by dearchiving the development archive and running:-
  39.  
  40.     hi edintro
  41.  
  42.       This  gives  basic instructions on how to add frames and notes, and
  43.       how to insert references in the text.
  44.  
  45.       If you practise using this, you will become familiar with the edit
  46.       mode, and with the structure of hyperfiles.
  47.  
  48.       It is a good idea to load HYPOP with the quick reference guide, so
  49.       that you can use it as a popup help system, using Alt-H. Do this
  50.       by unpacking the HYPOP archive and running 'hypop quickref.hyp'.
  51.  
  52.       Creating a new hyperfile
  53.       ------------------------
  54.  
  55.       New hyperfiles can be created using the 'hyperkit' hyperfile, or by
  56.       simply copying one of the template hyperfiles to a  file  with  the
  57.       name   you   want.   This  is  then  edited  using  the  integrated
  58.       environment.
  59.  
  60.       The integrated environment is not a fixed  format  program  with  a
  61.       predefined  set  of  functions,  like  certain programming language
  62.       development systems, but is a configurable environment which can be
  63.       set up to behave in different ways, depending on where it is  being
  64.       used.  The notefile hyperfile is an example of this, with a menubar
  65.       giving all the editing operations.
  66.  
  67.       When  editing  your  own  hyperfiles,  however,  the screen layout,
  68.       colours  etc.  are  part  of  your  application,  and  the  editing
  69.       functions are only there when you want them.  This is handled using
  70.       a   'control   hyperfile'  called  HS_IDE.HYP.  To  edit  your  own
  71.       hyperfile, make sure the files HI.EXE and  HS_IDE.HYP  are  in  the
  72.       current  directory,  along  with  your  hyperfile,  then  type  'hi
  73.       yourfile' where 'yourfile' is the name of your hyperfile.  Now,  to
  74.       edit  this  hyperfile,  just press the '#' key, and a menu will pop
  75.       up. This is the edit contol menu, and you can  choose  'Edit'  then
  76.       'Current frame' to edit the current frame, or 'Add' then 'Frame' to
  77.       add  a frame.  Follow the prompts to give the frame name and title,
  78.       and you will end up in edit mode. A number of other edit operations
  79.       which are similar to the notefile ones are also available from  the
  80.       edit  control  menu.  Experiment  with  a  sample  hyperfile before
  81.       progressing to a more ambitious project.
  82.  
  83.       Using a text editor
  84.       -------------------
  85.  
  86.       Alternatively,  if  you  have a text editor or word processor which
  87.       can  produce  text  files,  you  can  use  that  to  produce   your
  88.       hyperfiles. See the documentation on how to create hyperfiles.
  89.  
  90.       If you use a word processor and export the file as ASCII Text format
  91.       this is generally O.K., but you must be careful to not use margins
  92.       on the directives (.FRAME etc), and AVOID TRAILING SPACES on frame
  93.       and item names, as these will not match cross references etc.
  94.  
  95.       The next step
  96.       -------------
  97.  
  98.       After becoming familiar with the simple editing  capabilities,  you
  99.       can  read  the  documentation further to  get  ideas on what can be
  100.       done. This also contains full information on how the editor is used.
  101.  
  102.       Who HyperShell is intended for
  103.       ------------------------------
  104.  
  105.       HyperShell is intended  for  almost  anyone  who  uses  a  personal
  106.       computer  as it is a general purpose applications toolkit which can
  107.       be used for a diverse range of computer jobs.
  108.  
  109.       Existing HyperShell users have a very wide spectrum of  skills,  so
  110.       you  don't  have to be a programmer to make good use of the system.
  111.  
  112.       Don't try to do everything at once. Take things step by step as you
  113.       learn about the system.
  114.  
  115.       Good Luck, and enjoy using HyperShell.
  116.  
  117.  
  118.